/*
 * Copyright (c) 2020 Mike Penz
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *        http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.mikepenz.iconics.typeface;

import ohos.agp.text.Font;
import ohos.app.Context;
import ohos.utils.Pair;

import java.util.List;

/**
 * Created by mikepenz on 01.11.14.
 */
public interface ITypeface {
    /**
     * 获取字体资源文件
     *
     * @return 字体文件名
     */
    String getFontRes();

    /**
     * 解析字体
     *
     * @param context 上下文
     * @return 字体
     */
    Font getRawTypeface(Context context);

    /**
     * 获取icon字符表
     *
     * @return icon字符表
     */
    List<Pair<String, Character>> getCharacters();

    /**
     * The Mapping Prefix to identify this font must have a length of 3
     *
     * @return 匹配规则
     */
    String getMappingPrefix();

    /**
     * 获取字体名
     *
     * @return 字体名
     */
    String getFontName();

    /**
     * 获取版本号
     *
     * @return 版本号
     */
    String getVersion();

    /**
     * 获取icon字体总数
     *
     * @return icon字体数量
     */
    int getIconCount();

    /**
     * 获取字体icon
     *
     * @return 字体icon集合
     */
    List<String> getIcons();

    /**
     * 获取作者
     *
     * @return 作者
     */
    String getAuthor();

    /**
     * 获取字体链接
     *
     * @return 字体链接
     */
    String getUrl();

    /**
     * 获取字体描述
     *
     * @return 字体描述
     */
    String getDescription();

    /**
     * 获取字体版权
     *
     * @return 字体版权
     */
    String getLicense();

    /**
     * 获取字体版权链接
     *
     * @return 字体版权链接
     */
    String getLicenseUrl();

    /**
     * 获取字体图标
     *
     * @param key 字体字符
     * @return 字体图标
     */
    IIcon getIcon(String key);
}
